Blueprint Help Send comments on this topic.
SPX Close
See Also

Glossary Item Box

Description

This manual connection member function closes a previously opened splitter event.  Closing a splitter will cause it to automatically close its providing event (which will in turn close all of their retrieved events and so on).  When all of the splitter's links have closed a given event, then the collector that provided the event can itself be closed (which will then close all of its retrieved events).  Before using this member function, we would recommend familiarity with Manual Connections and Splitters.

Prototype

Uns Close( void );

Parameters

None

Return Value

This function returns logical TRUE if the connection is successfully closed; or FALSE otherwise.

Notes

Connections cannot be re-opened until they have been successfully closed.  Attempting to close a connection that was not successfully opened will generate a diagnostic.

Executing a close can unblock an adjacent requester that is blocked due to reentrancy considerations (see Object Reentrancy).

See Also